/*
 * Copyright 2009-2010 the original author or authors.
 *
 * Licensed under the Apache license, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.internna.iwebjtracker.server.scm.model;

import java.util.Date;

/**
 * Represents an entry in the log of the version control system.
 *
 * @author Jose Noheda
 * @since 1.0
 */
public interface LogEntry<R extends Revision, C extends Change> {

    /**
     * The developer who committed the code.
     *
     * @return any
     */
    String getAuthor();

    /**
     * The date this entry was created.
     *
     * @return a non null instance
     */
    Date getDate();

    /**
     * The revision this entry created.
     *
     * @return a non null instance
     */
    R getRevision();

    /**
     * The text the developer included with the commit.
     *
     * @return any
     */
    String message();

    /**
     * The collection of changes that happened in this revision.
     *
     * @return a non null instance.
     */
    ChangeSet<C> getChangeSet();

}
